package net.heavencraft.bejeweled.jewel;

/**
 * Represents the multiplier that is applied when a streak is triggered.
 * 
 * @author Sven
 * @author Wesley
 * 
 */
public enum StreakMultiplier {

	THREE(1), FOUR(2), FIVE(4);

	/**
	 * The streak Multiplier
	 */
	public final int multiplier;

	StreakMultiplier(int multiplier) {
		this.multiplier = multiplier;
	}

	/**
	 * Gets the multiplier of a streak
	 * 
	 * @param streak
	 *            The streak of wich we get the multiplier
	 * @return The multiplier of the specified streak
	 */
	public static StreakMultiplier getMultiplier(int streak) {
		switch (streak) {
		case 3:
			return THREE;
		case 4:
			return FOUR;
		case 5:
			return FIVE;
		default:
			return null;
		}
	}

	/**
	 * Gets the lower possible streak
	 * 
	 * @return The StreakMultiplier that is the smallest
	 */
	public static StreakMultiplier getLowest() {
		return THREE;
	}
}
